Switch readme to org-mode

diff --git a/README.md b/README.md
deleted file mode 100644 (file)
index 6f77947..0000000
--- a/README.md
+++ /dev/null
@@ -1,10 +0,0 @@
-# emacs-which-key
-Rewrite of guide-key-mode for emacs. 
-
-It's very rough right now. 
-
-Planned features:
-  1. Simplify code, especially the trigger mechanism to make it less resource
-     intensive than guide-key.
-  2. Add option to replace descriptions of keys on the fly.
-  3. Switch from using popwin to window-purpose.

diff --git a/README.org b/README.org
new file mode 100644 (file)
index 0000000..3fa356d
--- /dev/null
+++ b/README.org
@@ -0,0 +1,12 @@
+Rewrite of guide-key-mode for emacs. 
+
+* Status
+It is somewhat stable for me at the moment, but expect to see potentially weird
+behavior (then to report it to me!).
+** Completed
+1. Use idle timers to trigger window popup instead of guide-key's constant
+   polling.
+2. Add support for replacement lists to modify key descriptions on the fly.
+** Ongoing/Planned 
+1. Explore alternatives to popwin like window-pupose and using display-buffer
+   directly